home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chetrf.z / chetrf
Encoding:
Text File  |  2002-10-03  |  6.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))                                                          CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHETRF - compute the factorization of a complex Hermitian matrix A using
  10.      the Bunch-Kaufman diagonal pivoting method
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHETRF( UPLO, N, A, LDA, IPIV, WORK, LWORK, INFO )
  14.  
  15.          CHARACTER      UPLO
  16.  
  17.          INTEGER        INFO, LDA, LWORK, N
  18.  
  19.          INTEGER        IPIV( * )
  20.  
  21.          COMPLEX        A( LDA, * ), WORK( * )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      CHETRF computes the factorization of a complex Hermitian matrix A using
  38.      the Bunch-Kaufman diagonal pivoting method. The form of the factorization
  39.      is
  40.  
  41.         A = U*D*U**H  or  A = L*D*L**H
  42.  
  43.      where U (or L) is a product of permutation and unit upper (lower)
  44.      triangular matrices, and D is Hermitian and block diagonal with 1-by-1
  45.      and 2-by-2 diagonal blocks.
  46.  
  47.      This is the blocked version of the algorithm, calling Level 3 BLAS.
  48.  
  49.  
  50. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  51.      UPLO    (input) CHARACTER*1
  52.              = 'U':  Upper triangle of A is stored;
  53.              = 'L':  Lower triangle of A is stored.
  54.  
  55.      N       (input) INTEGER
  56.              The order of the matrix A.  N >= 0.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))                                                          CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) COMPLEX array, dimension (LDA,N)
  75.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  76.              by-N upper triangular part of A contains the upper triangular
  77.              part of the matrix A, and the strictly lower triangular part of A
  78.              is not referenced.  If UPLO = 'L', the leading N-by-N lower
  79.              triangular part of A contains the lower triangular part of the
  80.              matrix A, and the strictly upper triangular part of A is not
  81.              referenced.
  82.  
  83.              On exit, the block diagonal matrix D and the multipliers used to
  84.              obtain the factor U or L (see below for further details).
  85.  
  86.      LDA     (input) INTEGER
  87.              The leading dimension of the array A.  LDA >= max(1,N).
  88.  
  89.      IPIV    (output) INTEGER array, dimension (N)
  90.              Details of the interchanges and the block structure of D.  If
  91.              IPIV(k) > 0, then rows and columns k and IPIV(k) were
  92.              interchanged and D(k,k) is a 1-by-1 diagonal block.  If UPLO =
  93.              'U' and IPIV(k) = IPIV(k-1) < 0, then rows and columns k-1 and
  94.              -IPIV(k) were interchanged and D(k-1:k,k-1:k) is a 2-by-2
  95.              diagonal block.  If UPLO = 'L' and IPIV(k) = IPIV(k+1) < 0, then
  96.              rows and columns k+1 and -IPIV(k) were interchanged and
  97.              D(k:k+1,k:k+1) is a 2-by-2 diagonal block.
  98.  
  99.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  100.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  101.  
  102.      LWORK   (input) INTEGER
  103.              The length of WORK.  LWORK >=1.  For best performance LWORK >=
  104.              N*NB, where NB is the block size returned by ILAENV.
  105.  
  106.      INFO    (output) INTEGER
  107.              = 0:  successful exit
  108.              < 0:  if INFO = -i, the i-th argument had an illegal value
  109.              > 0:  if INFO = i, D(i,i) is exactly zero.  The factorization has
  110.              been completed, but the block diagonal matrix D is exactly
  111.              singular, and division by zero will occur if it is used to solve
  112.              a system of equations.
  113.  
  114. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  115.      If UPLO = 'U', then A = U*D*U', where
  116.         U = P(n)*U(n)* ... *P(k)U(k)* ...,
  117.      i.e., U is a product of terms P(k)*U(k), where k decreases from n to 1 in
  118.      steps of 1 or 2, and D is a block diagonal matrix with 1-by-1 and 2-by-2
  119.      diagonal blocks D(k).  P(k) is a permutation matrix as defined by
  120.      IPIV(k), and U(k) is a unit upper triangular matrix, such that if the
  121.      diagonal block D(k) is of order s (s = 1 or 2), then
  122.  
  123.                 (   I    v    0   )   k-s
  124.         U(k) =  (   0    I    0   )   s
  125.                 (   0    0    I   )   n-k
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))                                                          CCCCHHHHEEEETTTTRRRRFFFF((((3333SSSS))))
  137.  
  138.  
  139.  
  140.                    k-s   s   n-k
  141.  
  142.      If s = 1, D(k) overwrites A(k,k), and v overwrites A(1:k-1,k).  If s = 2,
  143.      the upper triangle of D(k) overwrites A(k-1,k-1), A(k-1,k), and A(k,k),
  144.      and v overwrites A(1:k-2,k-1:k).
  145.  
  146.      If UPLO = 'L', then A = L*D*L', where
  147.         L = P(1)*L(1)* ... *P(k)*L(k)* ...,
  148.      i.e., L is a product of terms P(k)*L(k), where k increases from 1 to n in
  149.      steps of 1 or 2, and D is a block diagonal matrix with 1-by-1 and 2-by-2
  150.      diagonal blocks D(k).  P(k) is a permutation matrix as defined by
  151.      IPIV(k), and L(k) is a unit lower triangular matrix, such that if the
  152.      diagonal block D(k) is of order s (s = 1 or 2), then
  153.  
  154.                 (   I    0     0   )  k-1
  155.         L(k) =  (   0    I     0   )  s
  156.                 (   0    v     I   )  n-k-s+1
  157.                    k-1   s  n-k-s+1
  158.  
  159.      If s = 1, D(k) overwrites A(k,k), and v overwrites A(k+1:n,k).  If s = 2,
  160.      the lower triangle of D(k) overwrites A(k,k), A(k+1,k), and A(k+1,k+1),
  161.      and v overwrites A(k+2:n,k:k+1).
  162.  
  163.  
  164. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  165.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  166.  
  167.      This man page is available only online.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.